3 * Import XML dump files into the current wiki.
5 * Copyright © 2005 Brion Vibber <brion@pobox.com>
6 * https://www.mediawiki.org/
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 * http://www.gnu.org/copyleft/gpl.html
24 * @ingroup Maintenance
27 require_once __DIR__
. '/Maintenance.php';
30 * Maintenance script that imports XML dump files into the current wiki.
32 * @ingroup Maintenance
34 class BackupReader
extends Maintenance
{
35 public $reportingInterval = 100;
36 public $pageCount = 0;
38 public $dryRun = false;
39 public $uploads = false;
40 protected $uploadCount = 0;
41 public $imageBasePath = false;
42 public $nsFilter = false;
44 function __construct() {
45 parent
::__construct();
46 $gz = in_array( 'compress.zlib', stream_get_wrappers() )
48 : '(disabled; requires PHP zlib module)';
49 $bz2 = in_array( 'compress.bzip2', stream_get_wrappers() )
51 : '(disabled; requires PHP bzip2 module)';
53 $this->addDescription(
55 This script reads pages from an XML file as produced from Special:Export or
56 dumpBackup.php, and saves them into the current wiki.
58 Compressed XML files may be read directly:
61 .7z (if 7za executable is in PATH)
63 Note that for very large data sets, importDump.php may be slow; there are
64 alternate methods which can be much faster for full site restoration:
65 <https://www.mediawiki.org/wiki/Manual:Importing_XML_dumps>
68 $this->stderr
= fopen( "php://stderr", "wt" );
69 $this->addOption( 'report',
70 'Report position and speed after every n pages processed', false, true );
71 $this->addOption( 'namespaces',
72 'Import only the pages from namespaces belonging to the list of ' .
73 'pipe-separated namespace names or namespace indexes', false, true );
74 $this->addOption( 'rootpage', 'Pages will be imported as subpages of the specified page',
76 $this->addOption( 'dry-run', 'Parse dump without actually importing pages' );
77 $this->addOption( 'debug', 'Output extra verbose debug information' );
78 $this->addOption( 'uploads', 'Process file upload data if included (experimental)' );
81 'Disable link table updates. Is faster but leaves the wiki in an inconsistent state'
83 $this->addOption( 'image-base-path', 'Import files from a specified path', false, true );
84 $this->addOption( 'skip-to', 'Start from nth page by skipping first n-1 pages', false, true );
85 $this->addOption( 'username-interwiki', 'Use interwiki usernames with this prefix', false, true );
86 $this->addOption( 'no-local-users',
87 'Treat all usernames as interwiki. ' .
88 'The default is to assign edits to local users where they exist.',
91 $this->addArg( 'file', 'Dump file to import [else use stdin]', false );
94 public function execute() {
96 $this->fatalError( "Wiki is in read-only mode; you'll need to disable it for import to work." );
99 $this->reportingInterval
= intval( $this->getOption( 'report', 100 ) );
100 if ( !$this->reportingInterval
) {
101 $this->reportingInterval
= 100; // avoid division by zero
104 $this->dryRun
= $this->hasOption( 'dry-run' );
105 $this->uploads
= $this->hasOption( 'uploads' ); // experimental!
106 if ( $this->hasOption( 'image-base-path' ) ) {
107 $this->imageBasePath
= $this->getOption( 'image-base-path' );
109 if ( $this->hasOption( 'namespaces' ) ) {
110 $this->setNsfilter( explode( '|', $this->getOption( 'namespaces' ) ) );
113 if ( $this->hasArg() ) {
114 $this->importFromFile( $this->getArg() );
116 $this->importFromStdin();
119 $this->output( "Done!\n" );
120 $this->output( "You might want to run rebuildrecentchanges.php to regenerate RecentChanges,\n" );
121 $this->output( "and initSiteStats.php to update page and revision counts\n" );
124 function setNsfilter( array $namespaces ) {
125 if ( count( $namespaces ) == 0 ) {
126 $this->nsFilter
= false;
130 $this->nsFilter
= array_unique( array_map( [ $this, 'getNsIndex' ], $namespaces ) );
133 private function getNsIndex( $namespace ) {
135 $result = $wgContLang->getNsIndex( $namespace );
136 if ( $result !== false ) {
139 $ns = intval( $namespace );
140 if ( strval( $ns ) === $namespace && $wgContLang->getNsText( $ns ) !== false ) {
143 $this->fatalError( "Unknown namespace text / index specified: $namespace" );
147 * @param Title|Revision $obj
150 private function skippedNamespace( $obj ) {
152 if ( $obj instanceof Title
) {
154 } elseif ( $obj instanceof Revision
) {
155 $title = $obj->getTitle();
156 } elseif ( $obj instanceof WikiRevision
) {
157 $title = $obj->title
;
159 throw new MWException( "Cannot get namespace of object in " . __METHOD__
);
162 if ( is_null( $title ) ) {
163 // Probably a log entry
167 $ns = $title->getNamespace();
169 return is_array( $this->nsFilter
) && !in_array( $ns, $this->nsFilter
);
172 function reportPage( $page ) {
177 * @param Revision $rev
179 function handleRevision( $rev ) {
180 $title = $rev->getTitle();
182 $this->progress( "Got bogus revision with null title!" );
187 if ( $this->skippedNamespace( $title ) ) {
194 if ( !$this->dryRun
) {
195 call_user_func( $this->importCallback
, $rev );
200 * @param Revision $revision
203 function handleUpload( $revision ) {
204 if ( $this->uploads
) {
205 if ( $this->skippedNamespace( $revision ) ) {
208 $this->uploadCount++
;
210 $this->progress( "upload: " . $revision->getFilename() );
212 if ( !$this->dryRun
) {
214 // call_user_func( $this->uploadCallback, $revision );
215 $dbw = $this->getDB( DB_MASTER
);
217 return $dbw->deadlockLoop( [ $revision, 'importUpload' ] );
224 function handleLogItem( $rev ) {
225 if ( $this->skippedNamespace( $rev ) ) {
231 if ( !$this->dryRun
) {
232 call_user_func( $this->logItemCallback
, $rev );
236 function report( $final = false ) {
237 if ( $final xor ( $this->pageCount %
$this->reportingInterval
== 0 ) ) {
242 function showReport() {
243 if ( !$this->mQuiet
) {
244 $delta = microtime( true ) - $this->startTime
;
246 $rate = sprintf( "%.2f", $this->pageCount
/ $delta );
247 $revrate = sprintf( "%.2f", $this->revCount
/ $delta );
252 # Logs dumps don't have page tallies
253 if ( $this->pageCount
) {
254 $this->progress( "$this->pageCount ($rate pages/sec $revrate revs/sec)" );
256 $this->progress( "$this->revCount ($revrate revs/sec)" );
262 function progress( $string ) {
263 fwrite( $this->stderr
, $string . "\n" );
266 function importFromFile( $filename ) {
267 if ( preg_match( '/\.gz$/', $filename ) ) {
268 $filename = 'compress.zlib://' . $filename;
269 } elseif ( preg_match( '/\.bz2$/', $filename ) ) {
270 $filename = 'compress.bzip2://' . $filename;
271 } elseif ( preg_match( '/\.7z$/', $filename ) ) {
272 $filename = 'mediawiki.compress.7z://' . $filename;
275 $file = fopen( $filename, 'rt' );
277 return $this->importFromHandle( $file );
280 function importFromStdin() {
281 $file = fopen( 'php://stdin', 'rt' );
282 if ( self
::posix_isatty( $file ) ) {
283 $this->maybeHelp( true );
286 return $this->importFromHandle( $file );
289 function importFromHandle( $handle ) {
290 $this->startTime
= microtime( true );
292 $source = new ImportStreamSource( $handle );
293 $importer = new WikiImporter( $source, $this->getConfig() );
295 // Updating statistics require a lot of time so disable it
296 $importer->disableStatisticsUpdate();
298 if ( $this->hasOption( 'debug' ) ) {
299 $importer->setDebug( true );
301 if ( $this->hasOption( 'no-updates' ) ) {
302 $importer->setNoUpdates( true );
304 if ( $this->hasOption( 'username-prefix' ) ) {
305 $importer->setUsernamePrefix(
306 $this->getOption( 'username-prefix' ),
307 !$this->hasOption( 'no-local-users' )
310 if ( $this->hasOption( 'rootpage' ) ) {
311 $statusRootPage = $importer->setTargetRootPage( $this->getOption( 'rootpage' ) );
312 if ( !$statusRootPage->isGood() ) {
313 // Die here so that it doesn't print "Done!"
314 $this->fatalError( $statusRootPage->getMessage()->text() );
318 if ( $this->hasOption( 'skip-to' ) ) {
319 $nthPage = (int)$this->getOption( 'skip-to' );
320 $importer->setPageOffset( $nthPage );
321 $this->pageCount
= $nthPage - 1;
323 $importer->setPageCallback( [ $this, 'reportPage' ] );
324 $this->importCallback
= $importer->setRevisionCallback(
325 [ $this, 'handleRevision' ] );
326 $this->uploadCallback
= $importer->setUploadCallback(
327 [ $this, 'handleUpload' ] );
328 $this->logItemCallback
= $importer->setLogItemCallback(
329 [ $this, 'handleLogItem' ] );
330 if ( $this->uploads
) {
331 $importer->setImportUploads( true );
333 if ( $this->imageBasePath
) {
334 $importer->setImageBasePath( $this->imageBasePath
);
337 if ( $this->dryRun
) {
338 $importer->setPageOutCallback( null );
341 return $importer->doImport();
345 $maintClass = 'BackupReader';
346 require_once RUN_MAINTENANCE_IF_MAIN
;